API 문서 만들기

✒️ 2025-05-15 11:09 내용 수정


  1. 문서를 eclipse에서 작성
package exam.comd.doc;
/**
* @author javaStudy
*/
public class Student {
	/**
	* 학생 이름
	*/
	private String myName;
	/**
	* 학생 나이
	*/
	private int age;

	/**
	* 학생 이름을 반환하는 메소드
	* @return
	*/
	public String getMyname() {
		return myName;
	}
	/**
	* 학생 이름을 입력하는 메소드
	* @return
	*/
	public String setMyname(String myName) {
		this.myName = myName;
	}

	public String getAge() {
		return myName;
	}
	public String setAge(String age) {
		this.age = age;
	}
}
  1. 문서 작성 완료 후 Project 탭 - Generate javaDoc을 실행
    • 설정 항목들을 Next로 넘겨준다.

javaDoc_project.png

javaDoc_project2.png

javaDoc_project3.png

  1. VM options 에서 아래 옵션을 추가해준다.
    • " -encoding UTF-8 -docencoding UTF-8 "
    • 추가해주지 않으면 인코딩 에러가 발생한다.

javaDoc_project4.png

  1. 컴퓨터에서 eclipse의 workspace 폴더 위치로 들어가서 방금 생성한 Java project의 doc 폴더로 들어간다.
    • " C:\workspace\프로젝트이름\doc\프로젝트이름\code\doc\문서이름 "

doc_finding1.png

  1. html 파일을 열면 웹사이트로 이동되고, eclipse에서 작성했던 내용이 아래처럼 정리되어 뜬다.

doc_ex1.png
doc_ex2.png